Add tabs to the documentation #3838
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Nice one! ❤️ Does this also work correctly on mobile-phone browsers? |
lurch
reviewed
Sep 7, 2024
Indeed it does. Tested on Android in Chromium and Firefox, and on iOS in Safari with success. Gets a little cramped sometimes, but very much usable. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uses https://github.com/asciidoctor/asciidoctor-tabs to introduce tabbed content to the docs.
Had to do some finagling to get the CSS and JS to work correctly. Then, customised the tab appearance to better fit in with our docs aesthetic.
Works well in testing. I'm going to roll out this low-risk single section update, monitor it for a week or so, and then improve additional sections of the docs as we move forward.
Bonus: because of this investigation, I also figured out how we can potentially add reproducible declarative diagrams to the docs with https://docs.asciidoctor.org/diagram-extension/latest/ (!!!). This is something the engineers have wanted for ages, and would dramatically reduce the amount of bad ascii art I'm forced to add to the docs at times. But I'll hold off on that until I'm confident that this is working well.
Before:
After: